Github API - Test Config

Flexydox

codespace-with-full-repository [object]

A codespace.

Attributes
billable_owner simple-user

simple-user [object]

A GitHub user.

Attributes
avatar_url string

email string

events_url string

followers_url string

following_url string

gists_url string

gravatar_id string

html_url string

id integer

login string

name string

node_id string

organizations_url string

received_events_url string

repos_url string

site_admin boolean

starred_at string

starred_url string

subscriptions_url string

type string

url string

API:
Github Open API
(version: 1.1.4)

https://api.github.com

created_at string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

devcontainer_path string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Path to devcontainer.json from repo root used to create Codespace.

display_name string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Display name for this codespace.

environment_id string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

UUID identifying this codespace's environment.

git_status 1944

1944 [object]

Details about the codespace's git repository.

Attributes
ahead integer

The number of commits the local repository is ahead of the remote.

behind integer

The number of commits the local repository is behind the remote.

has_uncommitted_changes boolean

Whether the local repository has uncommitted changes.

has_unpushed_changes boolean

Whether the local repository has unpushed changes.

ref string

The current branch (or SHA if in detached HEAD state) of the local repository.

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Details about the codespace's git repository.

id integer

integer [scalar]

The OpenAPI integer type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

idle_timeout_minutes integer

integer [scalar]

The OpenAPI integer type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

The number of minutes of inactivity after which this codespace will be automatically stopped.

idle_timeout_notice string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Text to show user when codespace idle timeout minutes has been overriden by an organization policy

last_used_at string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Last known time this codespace was started.

location string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

The Azure region where this codespace is located.

machine nullable-codespace-machine

nullable-codespace-machine [object]

A description of the machine powering a codespace.

Attributes
cpus integer

How many cores are available to the codespace.

display_name string

The display name of the machine includes cores, memory, and storage.

memory_in_bytes integer

How much memory is available to the codespace.

name string

The name of the machine.

operating_system string

The operating system of the machine.

prebuild_availability string

Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status.

storage_in_bytes integer

How much storage is available to the codespace.

API:
Github Open API
(version: 1.1.4)

https://api.github.com

machines_url string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

API URL to access available alternate machine types for this codespace.

name string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Automatically generated name of this codespace.

owner simple-user

simple-user [object]

A GitHub user.

Attributes
avatar_url string

email string

events_url string

followers_url string

following_url string

gists_url string

gravatar_id string

html_url string

id integer

login string

name string

node_id string

organizations_url string

received_events_url string

repos_url string

site_admin boolean

starred_at string

starred_url string

subscriptions_url string

type string

url string

API:
Github Open API
(version: 1.1.4)

https://api.github.com

pending_operation boolean

boolean [scalar]

The OpenAPI boolean type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.

pending_operation_disabled_reason string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Text to show user when codespace is disabled by a pending operation

prebuild boolean

boolean [scalar]

The OpenAPI boolean type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Whether the codespace was created from a prebuild.

publish_url string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

API URL to publish this codespace to a new repository.

pulls_url string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

API URL for the Pull Request associated with this codespace, if any.

recent_folders string []

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

repository full-repository

full-repository [object]

Full Repository

Attributes
allow_auto_merge boolean

allow_forking boolean

allow_merge_commit boolean

allow_rebase_merge boolean

allow_squash_merge boolean

allow_update_branch boolean

anonymous_access_enabled boolean

Whether anonymous git access is allowed.

archive_url string

archived boolean

assignees_url string

blobs_url string

branches_url string

clone_url string

code_of_conduct code-of-conduct-simple

collaborators_url string

comments_url string

commits_url string

compare_url string

contents_url string

contributors_url string

created_at string

default_branch string

delete_branch_on_merge boolean

deployments_url string

description string

disabled boolean

Returns whether or not this repository disabled.

downloads_url string

events_url string

fork boolean

forks integer

forks_count integer

forks_url string

full_name string

git_commits_url string

git_refs_url string

git_tags_url string

git_url string

has_discussions boolean

has_downloads boolean

has_issues boolean

has_pages boolean

has_projects boolean

has_wiki boolean

homepage string

hooks_url string

html_url string

id integer

is_template boolean

issue_comment_url string

issue_events_url string

issues_url string

keys_url string

labels_url string

language string

languages_url string

license nullable-license-simple

master_branch string

merge_commit_message string

The default value for a merge commit message.

  • PR_TITLE - default to the pull request's title.
  • PR_BODY - default to the pull request's body.
  • BLANK - default to a blank commit message.

merge_commit_title string

The default value for a merge commit title.

  • PR_TITLE - default to the pull request's title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

merges_url string

milestones_url string

mirror_url string

name string

network_count integer

node_id string

notifications_url string

open_issues integer

open_issues_count integer

organization nullable-simple-user

owner simple-user

parent repository

permissions 1989

private boolean

pulls_url string

pushed_at string

releases_url string

security_and_analysis security-and-analysis

size integer

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

source repository

squash_merge_commit_message string

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request's body.
  • COMMIT_MESSAGES - default to the branch's commit messages.
  • BLANK - default to a blank commit message.

squash_merge_commit_title string

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request's title.
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).

ssh_url string

stargazers_count integer

stargazers_url string

statuses_url string

subscribers_count integer

subscribers_url string

subscription_url string

svn_url string

tags_url string

teams_url string

temp_clone_token string

template_repository nullable-repository

topics string []

trees_url string

updated_at string

url string

use_squash_pr_title_as_default boolean

visibility string

The repository visibility: public, private, or internal.

watchers integer

watchers_count integer

web_commit_signoff_required boolean

API:
Github Open API
(version: 1.1.4)

https://api.github.com

retention_expires_at string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"

retention_period_minutes integer

integer [scalar]

The OpenAPI integer type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

runtime_constraints 1945

1945 [object]

Attributes
allowed_port_privacy_settings string []

API:
Github Open API
(version: 1.1.4)

https://api.github.com

start_url string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

API URL to start this codespace.

state string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

State of this codespace.

stop_url string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

API URL to stop this codespace.

updated_at string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

url string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

API URL for this codespace.

web_url string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

https://api.github.com

URL to access this codespace on the web.

API:
Github Open API
(version: 1.1.4)

https://api.github.com